<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
	<title>API: autocomplete  YAHOO.widget.AutoComplete   (YUI Library)</title>
	<link rel="stylesheet" type="text/css" href="assets/api.css">
</head>

<body id="yahoo-com">
<div id="doc3" class="yui-t2">

	<div id="hd">
        <h1>Yahoo! UI Library</h1>
        <h3>AutoComplete Widget&nbsp; <span class="subtitle">2.2.2</span></h3>
        <p>
        <a href="./index.html">Yahoo! UI Library</a> 
            &gt; <a href="./module_autocomplete.html">autocomplete</a>
                 &gt; YAHOO.widget.AutoComplete 
                
            </p>
	</div>

	<div id="bd">
		<div id="yui-main">
			<div class="yui-b">


                    <h2>
                        

                        
                        
                            Class <b>YAHOO.widget.AutoComplete</b>
                        <span class="extends">
                        </span>

                        <span class="extends">
                        </span>
                        
                        </code>
                    </h2>
                    <!-- class tree goes here -->
                    
                
  

                    <div class="summary description">
                        The AutoComplete class provides the customizable functionality of a plug-and-play DHTML
auto completion widget.  Some key features:
<ul>
<li>Navigate with up/down arrow keys and/or mouse to pick a selection</li>
<li>The drop down container can "roll down" or "fly out" via configurable
animation</li>
<li>UI look-and-feel customizable through CSS, including container
attributes, borders, position, fonts, etc</li>
</ul>
                    </div>

                        <div class="section constructor details">
                        <h3><a name="constructor_detail">Constructor</a></h3>
                        <div class="content">
                            <div class="detail">
                                <strong>YAHOO.widget.AutoComplete</strong>
                                <code>
                                    (
  
                                        
                                                
                                                elInput


                                                , 
                                                elContainer


                                                , 
                                                oDataSource

                                                , 
                                                oConfigs
                                    )
                                </code>
                                <div class="description">
                                        <dl>
                                            <dt>Parameters:</dt>
                                                <dd>
                                                    <code>elInput
                                                    &lt;HTMLElement&gt; 
                                                    </code>
                                                      DOM element reference of an input field.
                                                </dd>
                                                <dd>
                                                    <code>elInput
                                                    &lt;String&gt; 
                                                    </code>
                                                      String ID of an input field.
                                                </dd>
                                                <dd>
                                                    <code>elContainer
                                                    &lt;HTMLElement&gt; 
                                                    </code>
                                                      DOM element reference of an existing DIV.
                                                </dd>
                                                <dd>
                                                    <code>elContainer
                                                    &lt;String&gt; 
                                                    </code>
                                                      String ID of an existing DIV.
                                                </dd>
                                                <dd>
                                                    <code>oDataSource
                                                    &lt;YAHOO.widget.DataSource&gt; 
                                                    </code>
                                                      DataSource instance.
                                                </dd>
                                                <dd>
                                                    <code>oConfigs
                                                    &lt;Object&gt; 
                                                    </code>
                                                      (optional) Object literal of configuration params.
                                                </dd>
                                        </dl>
                                    
                                    
                                </div>
                            </div>
                        </div>
                    </div>

                        <div class="section field details">
                            <h3><a name="field_detail">Properties</a></h3>
                            <div class="content">
                                    <h4><a name="_aListItems">_aListItems</a>
                                        <code>- private HTMLElement[]</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Array of &lt;li&gt; elements references that contain query results within the
results container.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_bContainerOpen">_bContainerOpen</a>
                                        <code>- private Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Whether or not the results container is currently open.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_bFocused">_bFocused</a>
                                        <code>- private Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Whether or not the input field is currently in focus. If query results come back
but the user has already moved on, do not proceed with auto complete behavior.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_bItemSelected">_bItemSelected</a>
                                        <code>- private Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Whether or not an item has been selected since the container was populated
with results. Reset to false by _populateList, and set to true when item is
selected.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_bOverContainer">_bOverContainer</a>
                                        <code>- private Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Whether or not the mouse is currently over the results
container. This is necessary in order to prevent clicks on container items
from being text input field blur events.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_iFrameSrc">_iFrameSrc</a>
                                        <code>- private String</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Src to iFrame used when useIFrame = true. Supports implementations over SSL
as well.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_maxResultsDisplayed">_maxResultsDisplayed</a>
                                        <code>- private Number</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Internal count of &lt;li&gt; elements displayed and hidden in results container.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_nDelayID">_nDelayID</a>
                                        <code>- private Number</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Delay timeout ID.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_nDisplayedItems">_nDisplayedItems</a>
                                        <code>- private Number</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Number of &lt;li&gt; elements currently displayed in results container.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_nIndex">_nIndex</a>
                                        <code>- private Number</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Internal class variable to index multiple AutoComplete instances.
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: 0
                                    </div>        


                                    <hr />
                                    <h4><a name="_nKeyCode">_nKeyCode</a>
                                        <code>- private Number</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Key code of the last key pressed in textbox.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_oAnim">_oAnim</a>
                                        <code>- private Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Animation instance for container expand/collapse.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_oContainer">_oContainer</a>
                                        <code>- private HTMLElement</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Container DOM element.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_oCurItem">_oCurItem</a>
                                        <code>- private HTMLElement</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Pointer to the currently highlighted &lt;li&gt; element in the container.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_oTextbox">_oTextbox</a>
                                        <code>- private HTMLElement</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Text input field DOM element.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_queryInterval">_queryInterval</a>
                                        <code>- private Object</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            For users typing via certain IMEs, queries must be triggered by intervals,
since key events yet supported across all browsers for all IMEs.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_sCurQuery">_sCurQuery</a>
                                        <code>- private String</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Current query string
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_sName">_sName</a>
                                        <code>- private String</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Name of AutoComplete instance.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="_sSavedQuery">_sSavedQuery</a>
                                        <code>- private String</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Past queries this session (for saving delimited queries).
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="allowBrowserAutocomplete">allowBrowserAutocomplete</a>
                                        <code>- Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Whether or not to allow browsers to cache user-typed input in the input
field. Disabling this feature will prevent the widget from setting the
autocomplete="off" on the input field. When autocomplete="off"
and users click the back button after form submission, user-typed input can
be prefilled by the browser from its cache. This caching of user input may
not be desired for sensitive data, such as credit card numbers, in which
case, implementers should consider setting allowBrowserAutocomplete to false.
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: true
                                    </div>        


                                    <hr />
                                    <h4><a name="alwaysShowContainer">alwaysShowContainer</a>
                                        <code>- Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Whether or not the results container should always be displayed.
Enabling this feature displays the container when the widget is instantiated
and prevents the toggling of the container to a collapsed state.
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: false
                                    </div>        


                                    <hr />
                                    <h4><a name="animHoriz">animHoriz</a>
                                        <code>- Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Whether or not to animate the expansion/collapse of the results container in the
horizontal direction.
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: false
                                    </div>        


                                    <hr />
                                    <h4><a name="animSpeed">animSpeed</a>
                                        <code>- Number</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Speed of container expand/collapse animation, in seconds..
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: 0.3
                                    </div>        


                                    <hr />
                                    <h4><a name="animVert">animVert</a>
                                        <code>- Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Whether or not to animate the expansion/collapse of the results container in the
vertical direction.
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: true
                                    </div>        


                                    <hr />
                                    <h4><a name="autoHighlight">autoHighlight</a>
                                        <code>- Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Whether or not the first item in results container should be automatically highlighted
on expand.
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: true
                                    </div>        


                                    <hr />
                                    <h4><a name="dataSource">dataSource</a>
                                        <code>- YAHOO.widget.DataSource</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            The DataSource object that encapsulates the data used for auto completion.
This object should be an inherited object from YAHOO.widget.DataSource.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="delimChar">delimChar</a>
                                        <code>- String | String[]</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Query delimiter. A single character separator for multiple delimited
selections. Multiple delimiter characteres may be defined as an array of
strings. A null value or empty string indicates that query results cannot
be delimited. This feature is not recommended if you need forceSelection to
be true.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="forceSelection">forceSelection</a>
                                        <code>- Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Whether or not to force the user's selection to match one of the query
results. Enabling this feature essentially transforms the input field into a
&lt;select&gt; field. This feature is not recommended with delimiter character(s)
defined.
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: false
                                    </div>        


                                    <hr />
                                    <h4><a name="highlightClassName">highlightClassName</a>
                                        <code>- String</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Class name of a highlighted item within results container.
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: "yui-ac-highlight"
                                    </div>        


                                    <hr />
                                    <h4><a name="maxResultsDisplayed">maxResultsDisplayed</a>
                                        <code>- Number</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Maximum number of results to display in results container.
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: 10
                                    </div>        


                                    <hr />
                                    <h4><a name="minQueryLength">minQueryLength</a>
                                        <code>- Number</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Number of characters that must be entered before querying for results. A negative value
effectively turns off the widget. A value of 0 allows queries of null or empty string
values.
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: 1
                                    </div>        


                                    <hr />
                                    <h4><a name="prehighlightClassName">prehighlightClassName</a>
                                        <code>- String</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Class name of a pre-highlighted item within results container.
                                        </div>
                                    </div>
     
                                        


                                    <hr />
                                    <h4><a name="queryDelay">queryDelay</a>
                                        <code>- Number</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Number of seconds to delay before submitting a query request.  If a query
request is received before a previous one has completed its delay, the
previous request is cancelled and the new request is set to the delay.
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: 0.5
                                    </div>        


                                    <hr />
                                    <h4><a name="typeAhead">typeAhead</a>
                                        <code>- Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Whether or not the input field should be automatically updated
with the first query result as the user types, auto-selecting the substring
that the user has not typed.
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: false
                                    </div>        


                                    <hr />
                                    <h4><a name="useIFrame">useIFrame</a>
                                        <code>- Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Whether or not to use an iFrame to layer over Windows form elements in
IE. Set to true only when the results container will be on top of a
&lt;select&gt; field in IE and thus exposed to the IE z-index bug (i.e.,
5.5 < IE < 7).
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: false
                                    </div>        


                                    <hr />
                                    <h4><a name="useShadow">useShadow</a>
                                        <code>- Boolean</code>
                                    </h4>
                                    <div class="detail">
                                        <div class="description">
                                            Whether or not the results container should have a shadow.
                                        </div>
                                    </div>
     
                                        
                                    <div class="default">
                                        Default Value: false
                                    </div>        


                                    <hr />


                            </div>
                        </div>


                        <div class="section method details">
                            <h3><a name="methodDetails">Methods</a></h3>
                            <div class="content">
                                    <h4>
                                        <a name="__initProps">__initProps</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>__initProps</strong>
                                           (
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Updates and validates latest public config properties.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_cancelIntervalDetection">_cancelIntervalDetection</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_cancelIntervalDetection</strong>
                                           (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Cancels text input detection by intervals.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_clearSelection">_clearSelection</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_clearSelection</strong>
                                           (
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            When forceSelection is true and the user attempts
leave the text input box without selecting an item from the query results,
the user selection is cleared.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_enableIntervalDetection">_enableIntervalDetection</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_enableIntervalDetection</strong>
                                           (
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Enables query triggers based on text input detection by intervals (rather
than by key events).
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_initContainer">_initContainer</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_initContainer</strong>
                                           (
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Initializes the results container once at object creation
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_initContainerHelpers">_initContainerHelpers</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_initContainerHelpers</strong>
                                           (
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Initializes the results container helpers if they are enabled and do
not exist
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_initList">_initList</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_initList</strong>
                                           (
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Clears out contents of container body and creates up to
YAHOO.widget.AutoComplete#maxResultsDisplayed &lt;li&gt; elements in an
&lt;ul&gt; element.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_initListItem">_initListItem</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_initListItem</strong>
                                           (
                                                
                                                        
                                                         oItem
                                                    
                                                
                                                        , 
                                                         nItemIndex
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Initializes each &lt;li&gt; element in the container list.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oItem &lt;HTMLElement&gt;</code>
                                                              The &lt;li&gt; DOM element.
                                                        </dd>
                                                        <dd>
                                                            <code>nItemIndex &lt;Number&gt;</code>
                                                              The index of the element.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_isIgnoreKey">_isIgnoreKey</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        Boolean
                                            <strong>_isIgnoreKey</strong>
                                           (
                                                
                                                        
                                                         nKeycode
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Whether or not key is functional or should be ignored. Note that the right
arrow key is NOT an ignored key since it triggers queries for certain intl
charsets.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>nKeycode &lt;Number&gt;</code>
                                                              Code of key pressed.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        Boolean
                                                    </code></dt>
                                                    <dd>True if key should be ignored, false otherwise.</dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_jumpSelection">_jumpSelection</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_jumpSelection</strong>
                                           (
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            For values updated by type-ahead, the right arrow key jumps to the end
of the textbox, otherwise the container is closed.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_moveSelection">_moveSelection</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_moveSelection</strong>
                                           (
                                                
                                                        
                                                         nKeyCode
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Triggered by up and down arrow keys, changes the current highlighted
&lt;li&gt; element item. Scrolls container if necessary.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>nKeyCode &lt;Number&gt;</code>
                                                              Code of key pressed.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onContainerMouseout">_onContainerMouseout</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onContainerMouseout</strong>
                                           (
                                                
                                                        
                                                         v
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Handles container mouseout events.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>v &lt;HTMLEvent&gt;</code>
                                                              The mouseout event.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onContainerMouseover">_onContainerMouseover</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onContainerMouseover</strong>
                                           (
                                                
                                                        
                                                         v
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Handles container mouseover events.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>v &lt;HTMLEvent&gt;</code>
                                                              The mouseover event.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onContainerResize">_onContainerResize</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onContainerResize</strong>
                                           (
                                                
                                                        
                                                         v
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Handles container resize events.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>v &lt;HTMLEvent&gt;</code>
                                                              The resize event.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onContainerScroll">_onContainerScroll</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onContainerScroll</strong>
                                           (
                                                
                                                        
                                                         v
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Handles container scroll events.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>v &lt;HTMLEvent&gt;</code>
                                                              The scroll event.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onFormSubmit">_onFormSubmit</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onFormSubmit</strong>
                                           (
                                                
                                                        
                                                         v
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Handles form submission event.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>v &lt;HTMLEvent&gt;</code>
                                                              The submit event.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onIMEDetected">_onIMEDetected</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onIMEDetected</strong>
                                           (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Enables interval detection for  Korean IME support.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onItemMouseclick">_onItemMouseclick</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onItemMouseclick</strong>
                                           (
                                                
                                                        
                                                         v
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Handles &lt;li&gt; element click events in the container.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>v &lt;HTMLEvent&gt;</code>
                                                              The click event.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onItemMouseout">_onItemMouseout</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onItemMouseout</strong>
                                           (
                                                
                                                        
                                                         v
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Handles &lt;li&gt; element mouseout events in the container.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>v &lt;HTMLEvent&gt;</code>
                                                              The mouseout event.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onItemMouseover">_onItemMouseover</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onItemMouseover</strong>
                                           (
                                                
                                                        
                                                         v
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Handles &lt;li&gt; element mouseover events in the container.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>v &lt;HTMLEvent&gt;</code>
                                                              The mouseover event.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onTextboxBlur">_onTextboxBlur</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onTextboxBlur</strong>
                                           (
                                                
                                                        
                                                         v
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Handles text input box losing focus.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>v &lt;HTMLEvent&gt;</code>
                                                              The focus event.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onTextboxFocus">_onTextboxFocus</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onTextboxFocus</strong>
                                           (
                                                
                                                        
                                                         v
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Handles text input box receiving focus.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>v &lt;HTMLEvent&gt;</code>
                                                              The focus event.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onTextboxKeyDown">_onTextboxKeyDown</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onTextboxKeyDown</strong>
                                           (
                                                
                                                        
                                                         v
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Handles textbox keydown events of functional keys, mainly for UI behavior.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>v &lt;HTMLEvent&gt;</code>
                                                              The keydown event.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onTextboxKeyPress">_onTextboxKeyPress</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onTextboxKeyPress</strong>
                                           (
                                                
                                                        
                                                         v
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Handles textbox keypress events.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>v &lt;HTMLEvent&gt;</code>
                                                              The keypress event.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_onTextboxKeyUp">_onTextboxKeyUp</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_onTextboxKeyUp</strong>
                                           (
                                                
                                                        
                                                         v
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Handles textbox keyup events that trigger queries.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>v &lt;HTMLEvent&gt;</code>
                                                              The keyup event.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_populateList">_populateList</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_populateList</strong>
                                           (
                                                
                                                        
                                                         sQuery
                                                    
                                                
                                                        , 
                                                         aResults
                                                    
                                                
                                                        , 
                                                         oSelf
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Populates the array of &lt;li&gt; elements in the container with query
results. This method is passed to YAHOO.widget.DataSource#getResults as a
callback function so results from the DataSource instance are returned to the
AutoComplete instance.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>sQuery &lt;String&gt;</code>
                                                              The query string.
                                                        </dd>
                                                        <dd>
                                                            <code>aResults &lt;Object[]&gt;</code>
                                                              An array of query result objects from the DataSource.
                                                        </dd>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_selectItem">_selectItem</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_selectItem</strong>
                                           (
                                                
                                                        
                                                         oItem
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Selects a result item from the container
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oItem &lt;HTMLElement&gt;</code>
                                                              The selected &lt;li&gt; element item.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_selectText">_selectText</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_selectText</strong>
                                           (
                                                
                                                        
                                                         oTextbox
                                                    
                                                
                                                        , 
                                                         nStart
                                                    
                                                
                                                        , 
                                                         nEnd
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Selects text in the input field.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oTextbox &lt;HTMLElement&gt;</code>
                                                              Text input box element in which to select text.
                                                        </dd>
                                                        <dd>
                                                            <code>nStart &lt;Number&gt;</code>
                                                              Starting index of text string to select.
                                                        </dd>
                                                        <dd>
                                                            <code>nEnd &lt;Number&gt;</code>
                                                              Ending index of text selection.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_sendQuery">_sendQuery</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_sendQuery</strong>
                                           (
                                                
                                                        
                                                         sQuery
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Makes query request to the DataSource.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>sQuery &lt;String&gt;</code>
                                                              Query string.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_textMatchesOption">_textMatchesOption</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        Boolean
                                            <strong>_textMatchesOption</strong>
                                           (
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Whether or not user-typed value in the text input box matches any of the
query results.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        Boolean
                                                    </code></dt>
                                                    <dd>True if user-input text matches a result, false otherwise.</dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_toggleContainer">_toggleContainer</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_toggleContainer</strong>
                                           (
                                                
                                                        
                                                         bShow
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Animates expansion or collapse of the container.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>bShow &lt;Boolean&gt;</code>
                                                              True if container should be expanded, false if container should be collapsed
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_toggleContainerHelpers">_toggleContainerHelpers</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_toggleContainerHelpers</strong>
                                           (
                                                
                                                        
                                                         bShow
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Syncs results container with its helpers.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>bShow &lt;Boolean&gt;</code>
                                                              True if container is expanded, false if collapsed
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_toggleHighlight">_toggleHighlight</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_toggleHighlight</strong>
                                           (
                                                
                                                        
                                                         oNewItem
                                                    
                                                
                                                        , 
                                                         sType
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Toggles the highlight on or off for an item in the container, and also cleans
up highlighting of any previous item.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oNewItem &lt;HTMLElement&gt;</code>
                                                              The &lt;li&gt; element item to receive highlight behavior.
                                                        </dd>
                                                        <dd>
                                                            <code>sType &lt;String&gt;</code>
                                                              Type "mouseover" will toggle highlight on, and "mouseout" will toggle highlight off.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_togglePrehighlight">_togglePrehighlight</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_togglePrehighlight</strong>
                                           (
                                                
                                                        
                                                         oNewItem
                                                    
                                                
                                                        , 
                                                         sType
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Toggles the pre-highlight on or off for an item in the container.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oNewItem &lt;HTMLElement&gt;</code>
                                                              The &lt;li&gt; element item to receive highlight behavior.
                                                        </dd>
                                                        <dd>
                                                            <code>sType &lt;String&gt;</code>
                                                              Type "mouseover" will toggle highlight on, and "mouseout" will toggle highlight off.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_typeAhead">_typeAhead</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_typeAhead</strong>
                                           (
                                                
                                                        
                                                         oItem
                                                    
                                                
                                                        , 
                                                         sQuery
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Updates in the text input box with the first query result as the user types,
selecting the substring that the user has not typed.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oItem &lt;HTMLElement&gt;</code>
                                                              The &lt;li&gt; element item whose data populates the input field.
                                                        </dd>
                                                        <dd>
                                                            <code>sQuery &lt;String&gt;</code>
                                                              Query string.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="_updateValue">_updateValue</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                        void
                                            <strong>_updateValue</strong>
                                           (
                                                
                                                        
                                                         oItem
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Updates the text input box value with selected query result. If a delimiter
has been defined, then the value gets appended with the delimiter.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oItem &lt;HTMLElement&gt;</code>
                                                              The &lt;li&gt; element item with which to update the value.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="doBeforeExpandContainer">doBeforeExpandContainer</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                        Boolean
                                            <strong>doBeforeExpandContainer</strong>
                                           (
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Overridable method called before container expands allows implementers to access data
and DOM elements.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        Boolean
                                                    </code></dt>
                                                    <dd>Return true to continue expanding container, false to cancel the expand.</dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="formatResult">formatResult</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                        String
                                            <strong>formatResult</strong>
                                           (
                                                
                                                        
                                                         oResultItem
                                                    
                                                
                                                        , 
                                                         sQuery
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Overridable method that converts a result item object into HTML markup
for display. Return data values are accessible via the oResultItem object,
and the key return value will always be oResultItem[0]. Markup will be
displayed within &lt;li&gt; element tags in the container.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oResultItem &lt;Object&gt;</code>
                                                              Result item representing one query result. Data is held in an array.
                                                        </dd>
                                                        <dd>
                                                            <code>sQuery &lt;String&gt;</code>
                                                              The current query string.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        String
                                                    </code></dt>
                                                    <dd>HTML markup of formatted result data.</dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="getListItemData">getListItemData</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                        Object | Object[]
                                            <strong>getListItemData</strong>
                                           (
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Public accessor to the data held in an &lt;li&gt; element of the
results container.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        Object | Object[]
                                                    </code></dt>
                                                    <dd>Object or array of result data or null</dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="getListItems">getListItems</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                        HTMLElement[]
                                            <strong>getListItems</strong>
                                           (
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Public accessor to the internal array of DOM &lt;li&gt; elements that
display query results within the results container.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        HTMLElement[]
                                                    </code></dt>
                                                    <dd>Array of &lt;li&gt; elements within the results container.</dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="isContainerOpen">isContainerOpen</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                        Boolean
                                            <strong>isContainerOpen</strong>
                                           (
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Returns true if container is in an expanded state, false otherwise.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        Boolean
                                                    </code></dt>
                                                    <dd>Returns true if container is in an expanded state, false otherwise.</dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="sendQuery">sendQuery</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                        void
                                            <strong>sendQuery</strong>
                                           (
                                                
                                                        
                                                         sQuery
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Makes query request to the DataSource.
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>sQuery &lt;String&gt;</code>
                                                              Query string.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="setBody">setBody</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                        void
                                            <strong>setBody</strong>
                                           (
                                                
                                                        
                                                         sBody
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Sets HTML markup for the results container body. This markup will be
inserted within a &lt;div&gt; tag with a class of "yui-ac-bd".
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>sBody &lt;String&gt;</code>
                                                              HTML markup for results container body.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="setFooter">setFooter</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                        void
                                            <strong>setFooter</strong>
                                           (
                                                
                                                        
                                                         sFooter
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Sets HTML markup for the results container footer. This markup will be
inserted within a &lt;div&gt; tag with a class of "yui-ac-ft".
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>sFooter &lt;String&gt;</code>
                                                              HTML markup for results container footer.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="setHeader">setHeader</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                        void
                                            <strong>setHeader</strong>
                                           (
                                                
                                                        
                                                         sHeader
                                                    
                                                
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Sets HTML markup for the results container header. This markup will be
inserted within a &lt;div&gt; tag with a class of "yui-ac-hd".
                                        </div>

                                        <div class="description">

                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>sHeader &lt;String&gt;</code>
                                                              HTML markup for results container header.
                                                        </dd>
                                                </dl>

                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        void
                                                    </code></dt>
                                                    <dd></dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="toString">toString</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                        String
                                            <strong>toString</strong>
                                           (
                                            )
                                        </code>
                                        
                                        <div class="description">
                                            Public accessor to the unique name of the AutoComplete instance.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Returns:
                                                    <code>
                                                        String
                                                    </code></dt>
                                                    <dd>Unique name of the AutoComplete instance.</dd>
                                                </dl>
             
                                        </div>

                                    </div>
                                    <hr />
                            </div>
                        </div>


                        <div class="section method details">
                            <h3><a name="methodDetails">Events</a></h3>
                            <div class="content">
                                    <h4>
                                        <a name="_sLastTextboxValue">_sLastTextboxValue</a></h4>
                                    <div class="detail">
                                        <code>
                                         private 
                                        
                                        
                                            <strong>_sLastTextboxValue</strong>

                                            (
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Internal tracker to last known textbox value, used to determine whether or not
to trigger a query via interval for certain IME users.
                                        </div>

                                        <div class="description">




                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="containerCollapseEvent">containerCollapseEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>containerCollapseEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when the results container is collapsed.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="containerExpandEvent">containerExpandEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>containerExpandEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when the results container is expanded.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="dataErrorEvent">dataErrorEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>dataErrorEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                                        , 
                                                         sQuery
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when the AutoComplete instance does not receive query results from the
DataSource due to an error.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                        <dd>
                                                            <code>sQuery &lt;String&gt;</code>
                                                              The query string.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="dataRequestEvent">dataRequestEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>dataRequestEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                                        , 
                                                         sQuery
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when the AutoComplete instance makes a query to the DataSource.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                        <dd>
                                                            <code>sQuery &lt;String&gt;</code>
                                                              The query string.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="dataReturnEvent">dataReturnEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>dataReturnEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                                        , 
                                                         sQuery
                                                    
                                                
                                                        , 
                                                         aResults
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when the AutoComplete instance receives query results from the data
source.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                        <dd>
                                                            <code>sQuery &lt;String&gt;</code>
                                                              The query string.
                                                        </dd>
                                                        <dd>
                                                            <code>aResults &lt;Object[]&gt;</code>
                                                              Results array.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="itemArrowFromEvent">itemArrowFromEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>itemArrowFromEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                                        , 
                                                         elItem
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when result item has been arrowed away from.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                        <dd>
                                                            <code>elItem &lt;HTMLElement&gt;</code>
                                                              The &lt;li&gt; element item arrowed from.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="itemArrowToEvent">itemArrowToEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>itemArrowToEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                                        , 
                                                         elItem
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when result item has been arrowed to.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                        <dd>
                                                            <code>elItem &lt;HTMLElement&gt;</code>
                                                              The &lt;li&gt; element item arrowed to.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="itemMouseOutEvent">itemMouseOutEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>itemMouseOutEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                                        , 
                                                         elItem
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when result item has been moused out.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                        <dd>
                                                            <code>elItem &lt;HTMLElement&gt;</code>
                                                              The &lt;li&gt; element item moused from.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="itemMouseOverEvent">itemMouseOverEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>itemMouseOverEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                                        , 
                                                         elItem
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when result item has been moused over.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                        <dd>
                                                            <code>elItem &lt;HTMLElement&gt;</code>
                                                              The &lt;li&gt element item moused to.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="itemSelectEvent">itemSelectEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>itemSelectEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                                        , 
                                                         elItem
                                                    
                                                
                                                        , 
                                                         oData
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when an item is selected via mouse click, ENTER key, or TAB key.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                        <dd>
                                                            <code>elItem &lt;HTMLElement&gt;</code>
                                                              The selected &lt;li&gt; element item.
                                                        </dd>
                                                        <dd>
                                                            <code>oData &lt;Object&gt;</code>
                                                              The data returned for the item, either as an object,
or mapped from the schema into an array.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="selectionEnforceEvent">selectionEnforceEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>selectionEnforceEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired if forceSelection is enabled and the user's input has been cleared
because it did not match one of the returned query results.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="textboxBlurEvent">textboxBlurEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>textboxBlurEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when the input field loses focus.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="textboxFocusEvent">textboxFocusEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>textboxFocusEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when the input field receives focus.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="textboxKeyEvent">textboxKeyEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>textboxKeyEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                                        , 
                                                         nKeycode
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when the input field receives key input.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                        <dd>
                                                            <code>nKeycode &lt;Number&gt;</code>
                                                              The keycode number.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="typeAheadEvent">typeAheadEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>typeAheadEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                                        , 
                                                         sQuery
                                                    
                                                
                                                        , 
                                                         sPrefill
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when the input field has been prefilled by the type-ahead
feature.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                        <dd>
                                                            <code>sQuery &lt;String&gt;</code>
                                                              The query string.
                                                        </dd>
                                                        <dd>
                                                            <code>sPrefill &lt;String&gt;</code>
                                                              The prefill string.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                                    <h4>
                                        <a name="unmatchedItemSelectEvent">unmatchedItemSelectEvent</a></h4>
                                    <div class="detail">
                                        <code>
                                        
                                        
                                        
                                            <strong>unmatchedItemSelectEvent</strong>

                                            (
                                                
                                                        
                                                         oSelf
                                                    
                                                
                                                        , 
                                                         sQuery
                                                    
                                                
                                            )

                                        </code>
                                        
                                        <div class="description">
                                            Fired when a user selection does not match any of the displayed result items.
Note that this event may not behave as expected when delimiter characters
have been defined.
                                        </div>

                                        <div class="description">


                                                <dl>
                                                    <dt>Parameters:</dt>
                                                        <dd>
                                                            <code>oSelf &lt;YAHOO.widget.AutoComplete&gt;</code>
                                                              The AutoComplete instance.
                                                        </dd>
                                                        <dd>
                                                            <code>sQuery &lt;String&gt;</code>
                                                              The user-typed query string.
                                                        </dd>
                                                </dl>


                                        </div>

                                    </div>
                                    <hr />
                            </div>
                        </div>





			</div>
		</div>
		<div class="yui-b">
            <div class="nav">

                    <div class="module">
                        <h4>Modules</h4>
                        <ul class="content">

                                <li class=""><a href="module_animation.html">animation</a></li>

                                <li class="selected"><a href="module_autocomplete.html">autocomplete</a></li>

                                <li class=""><a href="module_button.html">button</a></li>

                                <li class=""><a href="module_calendar.html">calendar</a></li>

                                <li class=""><a href="module_connection.html">connection</a></li>

                                <li class=""><a href="module_container.html">container</a></li>

                                <li class=""><a href="module_datasource.html">datasource</a></li>

                                <li class=""><a href="module_datatable.html">datatable</a></li>

                                <li class=""><a href="module_dom.html">dom</a></li>

                                <li class=""><a href="module_dragdrop.html">dragdrop</a></li>

                                <li class=""><a href="module_element.html">element</a></li>

                                <li class=""><a href="module_event.html">event</a></li>

                                <li class=""><a href="module_history.html">history</a></li>

                                <li class=""><a href="module_logger.html">logger</a></li>

                                <li class=""><a href="module_menu.html">menu</a></li>

                                <li class=""><a href="module_slider.html">slider</a></li>

                                <li class=""><a href="module_tabview.html">tabview</a></li>

                                <li class=""><a href="module_treeview.html">treeview</a></li>

                                <li class=""><a href="module_yahoo.html">yahoo</a></li>
                        </ul>
                    </div>

                    <div class="module">
                        <h4>Classes</h4>
                        <ul class="content">
                                <li class="selected"><a href="YAHOO.widget.AutoComplete.html">YAHOO.widget.AutoComplete</a></li>
                                <li class=""><a href="YAHOO.widget.DataSource.html">YAHOO.widget.DataSource</a></li>
                                <li class=""><a href="YAHOO.widget.DS_JSArray.html">YAHOO.widget.DS_JSArray</a></li>
                                <li class=""><a href="YAHOO.widget.DS_JSFunction.html">YAHOO.widget.DS_JSFunction</a></li>
                                <li class=""><a href="YAHOO.widget.DS_XHR.html">YAHOO.widget.DS_XHR</a></li>
                        </ul>
                    </div>

                    <div class="module">
                        <h4>Files</h4>
                        <ul class="content">        
                                <li class=""><a href="AutoComplete.js.html">AutoComplete.js</a></li>
                                <li class=""><a href="DataSource.js.html">DataSource.js</a></li>
                        </ul>
                    </div>

                    <div class="module">
                        <h4>Properties</h4>
                        <ul class="content">        
                                <li><a href="#_aListItems">_aListItems</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_bContainerOpen">_bContainerOpen</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_bFocused">_bFocused</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_bItemSelected">_bItemSelected</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_bOverContainer">_bOverContainer</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_iFrameSrc">_iFrameSrc</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_maxResultsDisplayed">_maxResultsDisplayed</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_nDelayID">_nDelayID</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_nDisplayedItems">_nDisplayedItems</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_nIndex">_nIndex</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_nKeyCode">_nKeyCode</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_oAnim">_oAnim</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_oContainer">_oContainer</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_oCurItem">_oCurItem</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_oTextbox">_oTextbox</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_queryInterval">_queryInterval</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_sCurQuery">_sCurQuery</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_sName">_sName</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#_sSavedQuery">_sSavedQuery</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#allowBrowserAutocomplete">allowBrowserAutocomplete</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#alwaysShowContainer">alwaysShowContainer</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#animHoriz">animHoriz</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#animSpeed">animSpeed</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#animVert">animVert</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#autoHighlight">autoHighlight</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#dataSource">dataSource</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#delimChar">delimChar</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#forceSelection">forceSelection</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#highlightClassName">highlightClassName</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#maxResultsDisplayed">maxResultsDisplayed</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#minQueryLength">minQueryLength</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#prehighlightClassName">prehighlightClassName</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#queryDelay">queryDelay</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#typeAhead">typeAhead</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#useIFrame">useIFrame</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                                <li><a href="#useShadow">useShadow</a>
                                        <!--<code>&lt;Boolean&gt;</code>-->
                                </li>
                        </ul>
                    </div>

                    <div class="module">
                        <h4>Methods</h4>
                        <ul class="content">        
                                <li><!--<code>void</code>-->
                                <a href="#__initProps">__initProps</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_cancelIntervalDetection">_cancelIntervalDetection</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_clearSelection">_clearSelection</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_enableIntervalDetection">_enableIntervalDetection</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_initContainer">_initContainer</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_initContainerHelpers">_initContainerHelpers</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_initList">_initList</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_initListItem">_initListItem</a>
                                </li>
                                <li><!--<code>Boolean</code>-->
                                <a href="#_isIgnoreKey">_isIgnoreKey</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_jumpSelection">_jumpSelection</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_moveSelection">_moveSelection</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onContainerMouseout">_onContainerMouseout</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onContainerMouseover">_onContainerMouseover</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onContainerResize">_onContainerResize</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onContainerScroll">_onContainerScroll</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onFormSubmit">_onFormSubmit</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onIMEDetected">_onIMEDetected</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onItemMouseclick">_onItemMouseclick</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onItemMouseout">_onItemMouseout</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onItemMouseover">_onItemMouseover</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onTextboxBlur">_onTextboxBlur</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onTextboxFocus">_onTextboxFocus</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onTextboxKeyDown">_onTextboxKeyDown</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onTextboxKeyPress">_onTextboxKeyPress</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_onTextboxKeyUp">_onTextboxKeyUp</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_populateList">_populateList</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_selectItem">_selectItem</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_selectText">_selectText</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_sendQuery">_sendQuery</a>
                                </li>
                                <li><!--<code>Boolean</code>-->
                                <a href="#_textMatchesOption">_textMatchesOption</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_toggleContainer">_toggleContainer</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_toggleContainerHelpers">_toggleContainerHelpers</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_toggleHighlight">_toggleHighlight</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_togglePrehighlight">_togglePrehighlight</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_typeAhead">_typeAhead</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#_updateValue">_updateValue</a>
                                </li>
                                <li><!--<code>Boolean</code>-->
                                <a href="#doBeforeExpandContainer">doBeforeExpandContainer</a>
                                </li>
                                <li><!--<code>String</code>-->
                                <a href="#formatResult">formatResult</a>
                                </li>
                                <li><!--<code>Object | Object[]</code>-->
                                <a href="#getListItemData">getListItemData</a>
                                </li>
                                <li><!--<code>HTMLElement[]</code>-->
                                <a href="#getListItems">getListItems</a>
                                </li>
                                <li><!--<code>Boolean</code>-->
                                <a href="#isContainerOpen">isContainerOpen</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#sendQuery">sendQuery</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#setBody">setBody</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#setFooter">setFooter</a>
                                </li>
                                <li><!--<code>void</code>-->
                                <a href="#setHeader">setHeader</a>
                                </li>
                                <li><!--<code>String</code>-->
                                <a href="#toString">toString</a>
                                </li>
                        </ul>
                    </div>

                    <div class="module">
                        <h4>Events</h4>
                        <ul class="content">        
                                <li>
                                <a href="#_sLastTextboxValue">_sLastTextboxValue</a>
                                </li>
                                <li>
                                <a href="#containerCollapseEvent">containerCollapseEvent</a>
                                </li>
                                <li>
                                <a href="#containerExpandEvent">containerExpandEvent</a>
                                </li>
                                <li>
                                <a href="#dataErrorEvent">dataErrorEvent</a>
                                </li>
                                <li>
                                <a href="#dataRequestEvent">dataRequestEvent</a>
                                </li>
                                <li>
                                <a href="#dataReturnEvent">dataReturnEvent</a>
                                </li>
                                <li>
                                <a href="#itemArrowFromEvent">itemArrowFromEvent</a>
                                </li>
                                <li>
                                <a href="#itemArrowToEvent">itemArrowToEvent</a>
                                </li>
                                <li>
                                <a href="#itemMouseOutEvent">itemMouseOutEvent</a>
                                </li>
                                <li>
                                <a href="#itemMouseOverEvent">itemMouseOverEvent</a>
                                </li>
                                <li>
                                <a href="#itemSelectEvent">itemSelectEvent</a>
                                </li>
                                <li>
                                <a href="#selectionEnforceEvent">selectionEnforceEvent</a>
                                </li>
                                <li>
                                <a href="#textboxBlurEvent">textboxBlurEvent</a>
                                </li>
                                <li>
                                <a href="#textboxFocusEvent">textboxFocusEvent</a>
                                </li>
                                <li>
                                <a href="#textboxKeyEvent">textboxKeyEvent</a>
                                </li>
                                <li>
                                <a href="#typeAheadEvent">typeAheadEvent</a>
                                </li>
                                <li>
                                <a href="#unmatchedItemSelectEvent">unmatchedItemSelectEvent</a>
                                </li>
                        </ul>
                    </div>


            </div>
		</div>
	</div>
	<div id="ft">
        <hr />
        Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
	</div>
</div>
</body>
</html>
